Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update on-oci-vm.md #7890

Merged
merged 1 commit into from
Nov 15, 2021
Merged

Update on-oci-vm.md #7890

merged 1 commit into from
Nov 15, 2021

Conversation

shadabshaukat
Copy link
Contributor

Fixes

  • URL fix for Airbyte docker image
  • URL fix for Docker compose download
  • Text Formatting Fix

What

Describe what the change is solving
Fixing URL issues and fixing text formatting issues. I was the original author of this deployment guide and i found due to the "```text" tag not being used the commands were coming incorrect on console

It helps to add screenshots if it affects the frontend.

How

Describe the solution

Recommended reading order

  1. x.java
  2. y.python

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the new connector version is published, connector version bumped in the seed directory as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Connector Generator

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed.

@shadabshaukat
Update on-oci-vm.md
7c60e0a 
Fixes
- URL fix for Airbyte docker image
- URL fix for Docker compose download
- Text Formatting Fix
@CLAassistant
Copy link

CLAassistant commented Nov 12, 2021 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Nov 12, 2021
jrhizor
jrhizor reviewed Nov 12, 2021
View reviewed changes
docs/deploying-airbyte/on-oci-vm.md

which docker-compose

sudo /usr/local/bin/docker-compose up -d
docker-compose up -d
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this still be sudo? I think this is the only non-formatting change here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will work without sudo. Added the text tags also to avoid errors on copying pasting

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@jrhizor
Copy link
Contributor

jrhizor commented Nov 15, 2021

Thanks for the doc updates!

@jrhizor jrhizor merged commit f4e3687 into airbytehq:master Nov 15, 2021
This was referenced Nov 16, 2021
Closed
Merged
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
@shadabshaukat @schlattk
Update on-oci-vm.md (airbytehq#7890)
7ad34ca 
Fixes
- URL fix for Airbyte docker image
- URL fix for Docker compose download
- Text Formatting Fix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jrhizor jrhizor jrhizor approved these changes

Assignees
No one assigned
Labels
area/documentation Improvements or additions to documentation community
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@shadabshaukat @CLAassistant @jrhizor @octavia-squidington-iii